home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.n / info.n < prev    next >
Text File  |  1995-07-25  |  11KB  |  199 lines
  1.  
  2.  
  3.  
  4.      iiiinnnnffffoooo((((nnnn))))                     TTTTccccllll ((((7777....0000))))                     iiiinnnnffffoooo((((nnnn))))
  5.  
  6.  
  7.  
  8.      _________________________________________________________________
  9.  
  10.      NNNNAAAAMMMMEEEE
  11.           info -  Return  information  about  the  state  of  the  Tcl
  12.           interpreter
  13.  
  14.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.           iiiinnnnffffoooo _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  16.      _________________________________________________________________
  17.  
  18.  
  19.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.           This command provides information about various internals of
  21.           the  Tcl  interpreter.   The  legal  _o_p_t_i_o_n's  (which may be
  22.           abbreviated) are:
  23.  
  24.           iiiinnnnffffoooo aaaarrrrggggssss _p_r_o_c_n_a_m_e
  25.                Returns a list containing the names of the arguments to
  26.                procedure  _p_r_o_c_n_a_m_e,  in  order.   _P_r_o_c_n_a_m_e must be the
  27.                name of a Tcl command procedure.
  28.  
  29.           iiiinnnnffffoooo bbbbooooddddyyyy _p_r_o_c_n_a_m_e
  30.                Returns the body of procedure _p_r_o_c_n_a_m_e.  _P_r_o_c_n_a_m_e  must
  31.                be the name of a Tcl command procedure.
  32.  
  33.           iiiinnnnffffoooo ccccmmmmddddccccoooouuuunnnntttt
  34.                Returns a count of the total number  of  commands  that
  35.                have been invoked in this interpreter.
  36.  
  37.           iiiinnnnffffoooo ccccoooommmmmmmmaaaannnnddddssss ?_p_a_t_t_e_r_n?
  38.                If _p_a_t_t_e_r_n isn't specified, returns a list of names  of
  39.                all  the  Tcl  commands,  including  both  the built-in
  40.                commands  written  in  C  and  the  command  procedures
  41.                defined   using   the  pppprrrroooocccc  command.   If  _p_a_t_t_e_r_n  is
  42.                specified,  only  those  names  matching  _p_a_t_t_e_r_n   are
  43.                returned.   Matching is determined using the same rules
  44.                as for ssssttttrrrriiiinnnngggg mmmmaaaattttcccchhhh.
  45.  
  46.           iiiinnnnffffoooo ccccoooommmmpppplllleeeetttteeee _c_o_m_m_a_n_d
  47.                Returns 1 if _c_o_m_m_a_n_d is a complete Tcl command  in  the
  48.                sense of having no unclosed quotes, braces, brackets or
  49.                array element names, If the command doesn't  appear  to
  50.                be  complete  then  0  is  returned.   This  command is
  51.                typically used in line-oriented input  environments  to
  52.                allow  users  to  type  in  commands that span multiple
  53.                lines;  if the command isn't complete, the  script  can
  54.                delay  evaluating  it  until additional lines have been
  55.                typed to complete the command.
  56.  
  57.           iiiinnnnffffoooo ddddeeeeffffaaaauuuulllltttt _p_r_o_c_n_a_m_e _a_r_g _v_a_r_n_a_m_e
  58.                _P_r_o_c_n_a_m_e must be the name of a  Tcl  command  procedure
  59.                and  _a_r_g  must  be  the  name  of  an  argument to that
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/17/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      iiiinnnnffffoooo((((nnnn))))                     TTTTccccllll ((((7777....0000))))                     iiiinnnnffffoooo((((nnnn))))
  71.  
  72.  
  73.  
  74.                procedure.  If _a_r_g doesn't have a  default  value  then
  75.                the  command  returns  0000.   Otherwise  it returns 1111 and
  76.                places the default value of _a_r_g into variable _v_a_r_n_a_m_e.
  77.  
  78.           iiiinnnnffffoooo eeeexxxxiiiissssttttssss _v_a_r_N_a_m_e
  79.                Returns 1111 if the variable named _v_a_r_N_a_m_e exists  in  the
  80.                current context (either as a global or local variable),
  81.                returns 0000 otherwise.
  82.  
  83.           iiiinnnnffffoooo gggglllloooobbbbaaaallllssss ?_p_a_t_t_e_r_n?
  84.                If _p_a_t_t_e_r_n isn't specified, returns a list of  all  the
  85.                names   of   currently-defined  global  variables.   If
  86.                _p_a_t_t_e_r_n is specified, only those names matching _p_a_t_t_e_r_n
  87.                are  returned.   Matching  is determined using the same
  88.                rules as for ssssttttrrrriiiinnnngggg mmmmaaaattttcccchhhh.
  89.  
  90.           iiiinnnnffffoooo lllleeeevvvveeeellll ?_n_u_m_b_e_r?
  91.                If _n_u_m_b_e_r is not  specified,  this  command  returns  a
  92.                number   giving   the   stack  level  of  the  invoking
  93.                procedure, or 0 if the command is invoked at top-level.
  94.                If  _n_u_m_b_e_r  is  specified,  then  the  result is a list
  95.                consisting of the name and arguments for the  procedure
  96.                call  at  level  _n_u_m_b_e_r  on  the  stack.   If _n_u_m_b_e_r is
  97.                positive then it selects a particular  stack  level  (1
  98.                refers  to  the  top-most  active  procedure,  2 to the
  99.                procedure it called, and so on); otherwise it  gives  a
  100.                level  relative  to  the current level (0 refers to the
  101.                current procedure, -1 to its caller, and so  on).   See
  102.                the  uuuupppplllleeeevvvveeeellll command for more information on what stack
  103.                levels mean.
  104.  
  105.           iiiinnnnffffoooo lllliiiibbbbrrrraaaarrrryyyy
  106.                Returns the name of  the  library  directory  in  which
  107.                standard Tcl scripts are stored.  The default value for
  108.                the library  is  compiled  into  Tcl,  but  it  may  be
  109.                overridden   by  setting  the  TCL_LIBRARY  environment
  110.                variable.  If there is no TCL_LIBRARY variable  and  no
  111.                compiled-in value then and error is generated.  See the
  112.                lllliiiibbbbrrrraaaarrrryyyy manual entry  for  details  of  the  facilities
  113.                provided  by  the  Tcl  script  library.  Normally each
  114.                application  will  have  its  own  application-specific
  115.                script  library  in addition to the Tcl script library;
  116.                I suggest that each application set a  global  variable
  117.                with  a  name  like  $$$$_a_p_p____lllliiiibbbbrrrraaaarrrryyyy  (where  _a_p_p  is  the
  118.                application's  name)  to  hold  the  location  of  that
  119.                application's library directory.
  120.  
  121.           iiiinnnnffffoooo llllooooccccaaaallllssss ?_p_a_t_t_e_r_n?
  122.                If _p_a_t_t_e_r_n isn't specified, returns a list of  all  the
  123.                names  of  currently-defined local variables, including
  124.                arguments to the current procedure, if any.   Variables
  125.                defined  with the gggglllloooobbbbaaaallll and uuuuppppvvvvaaaarrrr commands will not be
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 7/17/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      iiiinnnnffffoooo((((nnnn))))                     TTTTccccllll ((((7777....0000))))                     iiiinnnnffffoooo((((nnnn))))
  137.  
  138.  
  139.  
  140.                returned.  If _p_a_t_t_e_r_n is specified,  only  those  names
  141.                matching  _p_a_t_t_e_r_n are returned.  Matching is determined
  142.                using the same rules as for ssssttttrrrriiiinnnngggg mmmmaaaattttcccchhhh.
  143.  
  144.           iiiinnnnffffoooo ppppaaaattttcccchhhhlllleeeevvvveeeellll
  145.                Returns a decimal  integer  giving  the  current  patch  |
  146.                level for Tcl.  The patch level is incremented for each  |
  147.                new release or patch, and  it  uniquely  identifies  an  |
  148.                official version of Tcl.
  149.  
  150.           iiiinnnnffffoooo pppprrrrooooccccssss ?_p_a_t_t_e_r_n?
  151.                If _p_a_t_t_e_r_n isn't specified, returns a list of  all  the
  152.                names   of  Tcl  command  procedures.   If  _p_a_t_t_e_r_n  is
  153.                specified,  only  those  names  matching  _p_a_t_t_e_r_n   are
  154.                returned.   Matching is determined using the same rules
  155.                as for ssssttttrrrriiiinnnngggg mmmmaaaattttcccchhhh.
  156.  
  157.           iiiinnnnffffoooo ssssccccrrrriiiipppptttt
  158.                If a Tcl script file is currently being evaluated (i.e.
  159.                there  is  a call to TTTTccccllll____EEEEvvvvaaaallllFFFFiiiilllleeee active or there is an
  160.                active invocation of the  ssssoooouuuurrrrcccceeee  command),  then  this
  161.                command  returns  the  name of the innermost file being
  162.                processed.  Otherwise  the  command  returns  an  empty
  163.                string.
  164.  
  165.           iiiinnnnffffoooo ttttccccllllvvvveeeerrrrssssiiiioooonnnn
  166.                Returns the version number for this version of  Tcl  in
  167.                the  form  _x._y,  where  changes  to  _x  represent major
  168.                changes with probable incompatibilities and changes  to
  169.                _y  represent  small  enhancements  and  bug  fixes that
  170.                retain backward compatibility.
  171.  
  172.           iiiinnnnffffoooo vvvvaaaarrrrssss ?_p_a_t_t_e_r_n?
  173.                If _p_a_t_t_e_r_n isn't specified, returns a list of  all  the
  174.                names  of  currently-visible  variables, including both
  175.                locals and currently-visible globals.   If  _p_a_t_t_e_r_n  is
  176.                specified,   only  those  names  matching  _p_a_t_t_e_r_n  are
  177.                returned.  Matching is determined using the same  rules
  178.                as for ssssttttrrrriiiinnnngggg mmmmaaaattttcccchhhh.
  179.  
  180.  
  181.      KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  182.           command,   information,   interpreter,   level,   procedure,
  183.           variable
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 7/17/95)
  196.  
  197.  
  198.  
  199.